Skip to content

Comments

Add tool usage scenarios#13

Open
harp-intel wants to merge 5 commits intomainfrom
tool-chooser
Open

Add tool usage scenarios#13
harp-intel wants to merge 5 commits intomainfrom
tool-chooser

Conversation

@harp-intel
Copy link
Contributor

This pull request updates the tools/README.md file to provide a more comprehensive, user-friendly, and decision-oriented overview of available performance monitoring and profiling tools. The documentation now includes clearer tool descriptions, best-use scenarios, and a decision guide to help users select the right tool for their needs.

Documentation improvements:

  • Expanded each tool's description to clarify its primary use cases, advantages, and best-fit scenarios.
  • Added a "Choosing the Right Tool" section with a decision-tree format to help users quickly identify which tool to use based on their performance analysis goals.
  • Grouped tools by typical user needs (e.g., quick assessment, deep optimization, cluster analysis, memory/bandwidth issues, GPU optimization, power monitoring, call stack visualization).
  • Improved readability with thematic headings, bullet points, and emoji highlights for best-use cases and key advantages.

Signed-off-by: Harper, Jason M <jason.m.harper@intel.com>
@napetrov
Copy link

napetrov commented Feb 4, 2026

It might be good to expand optimization-zone knowledge and recommendations beyond tools to libraries and brooder - how to run efficiently and performant on IA - https://context7.com/intel/optimization-zone?tab=benchmark
So this might be for example used for doc/context management for coding tools

Signed-off-by: Harper, Jason M <jason.m.harper@intel.com>
Signed-off-by: Harper, Jason M <jason.m.harper@intel.com>
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates tools/README.md to provide a more decision-oriented reference for selecting performance monitoring and profiling tools in this repository.

Changes:

  • Replaces the previous short tool summary list with structured “Intel® Tools Reference” and “Other Tools Reference” sections.
  • Adds a “Choosing the Right Tool” decision guide organized by common performance investigation goals.
  • Expands per-tool descriptions with “Best for” / advantage-focused guidance.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@rsiyer-intel
Copy link
Collaborator

Looks great.

  • For someone who is new to tools, may be we should have a difficulty/expertise level. Perfspect - easy to install, VTune - advanced - needs expertise, gprofiler - single node easy to start, multi-node - intermediate/expert level,

  • baremetal vs cloud scenarios - recommended to use perfspect for quick insights in cloud environment, VTune/PCM etc depends on availability of PMU counters on cloud vendors.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants